Skip to content

feat: add C implementation for studentized range quantile #8551

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

feat: add C implementation for studentized range quantile #8551

wants to merge 1 commit into from

Conversation

@GlyphicGuy
Copy link

@GlyphicGuy GlyphicGuy commented Nov 18, 2025

Resolves #3888.

Description

What is the purpose of this pull request?

This pull request:

  • Adds a C implementation for the studentized-range quantile function (@stdlib/stats/base/dists/studentized-range/quantile)
  • Implements the C quantile function with helper routines for normal inverse CDF approximation and iterative root-finding using regula falsi method
  • Adds N-API Node.js addon bindings to expose the C implementation to JavaScript
  • Includes native wrapper (lib/native.js) that seamlessly integrates with the existing JS implementation
  • Adds comprehensive native test suite (test/test.native.js) for validating the C implementation
  • Includes C benchmarks and examples for performance testing
  • Updates README with C API documentation and usage examples
  • Fixes header file to include <stdint.h> for proper int32_t type definition

Related Issues

Does this pull request have any related issues?

This pull request has the following related issues:

  • #{{TODO: add related issue number}}

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

  • Yes
  • No

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

Disclosure

I used GitHub Copilot to implement this C functionality, helping with understanding the repository structure and stdlib conventions for native implementations

I manually checked and verified all JavaScript tests pass locally (245 tests) and that the conventions were followed.

@stdlib-js/reviewers

@stdlib-bot
Copy link
Contributor

stdlib-bot commented Nov 18, 2025

👋 Hi there! 👋

And thank you for opening your first pull request! We will review it shortly. 🏃 💨

Getting Started

Next Steps

  1. A project maintainer will approve GitHub Actions workflows for your PR.
  2. All CI checks must pass before your submission can be fully reviewed.
  3. You'll need to address any failures in linting or unit tests.

Running Tests Locally

You can use make to run any of the CI commands locally from the root directory of the stdlib repository:

# Run tests for all packages in the math namespace:
make test TESTS_FILTER=".*/@stdlib/math/.*"

# Run benchmarks for a specific package:
make benchmark BENCHMARKS_FILTER=".*/@stdlib/math/base/special/sin/.*"

If you haven't heard back from us within two weeks, please ping us by tagging the "reviewers" team in a comment on this PR.

If you have any further questions while waiting for a response, please join our Gitter channel to chat with project maintainers and other community members.

We appreciate your contribution!

Documentation Links

@stdlib-bot stdlib-bot added Statistics Issue or pull request related to statistical functionality. First-time Contributor A pull request from a contributor who has never previously committed to the project repository. Needs Review A pull request which needs code review. Good First PR A pull request resolving a Good First Issue. labels Nov 18, 2025
@stdlib-bot
Copy link
Contributor

stdlib-bot commented Nov 18, 2025

Coverage Report

Package Statements Branches Functions Lines
stats/base/dists/studentized-range/quantile $\color{red}600/640$
$color{green}+93.75%$ 		$\color{red}65/81$
$color{green}+80.25%$ 		$\color{red}5/6$
$color{green}+83.33%$ 		$\color{red}600/640$
$color{green}+93.75%$

The above coverage report was generated for the changes in this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

First-time Contributor A pull request from a contributor who has never previously committed to the project repository. Good First PR A pull request resolving a Good First Issue. Needs Review A pull request which needs code review. Statistics Issue or pull request related to statistical functionality.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[RFC]: Add C implementation for @stdlib/stats/base/dists/studentized-range/quantile

2 participants

@GlyphicGuy @stdlib-bot